<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../luadoc.css" type="text/css" />
	<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>

<body>
<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->

<div id="main">

<div id="navigation">


<h1>LuaDoc</h1>
<ul>
	
	<li><a href="../index.html">Index</a></li>
	
</ul>


<!-- Module list -->



<!-- File list -->

<h1>Files</h1>
<ul>

	<li>
		<a href="../files/lime-map.html">lime-map.lua</a>
	</li>

	<li>
		<a href="../files/lime-object.html">lime-object.lua</a>
	</li>

	<li><strong>lime-objectLayer.lua</strong></li>
	
	<li>
		<a href="../files/lime-property.html">lime-property.lua</a>
	</li>

	<li>
		<a href="../files/lime-tile.html">lime-tile.lua</a>
	</li>

	<li>
		<a href="../files/lime-tileLayer.html">lime-tileLayer.lua</a>
	</li>

	<li>
		<a href="../files/lime-tileset.html">lime-tileset.lua</a>
	</li>

	<li>
		<a href="../files/lime-utils.html">lime-utils.lua</a>
	</li>

	<li>
		<a href="../files/lime.html">lime.lua</a>
	</li>

</ul>






</div> <!-- id="navigation" -->

<div id="content">

<h1>File <code>lime-objectLayer.lua</code></h1>







<h2>Functions</h2>
<table class="function_list">

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:addProperty">ObjectLayer:addProperty</a>&nbsp;(property)</td>
	<td class="summary">Adds a Property to the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:build">ObjectLayer:build</a>&nbsp;()</td>
	<td class="summary">Builds the physical representation of the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:create">ObjectLayer:create</a>&nbsp;()</td>
	<td class="summary">Creates the visual debug representation of the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:destroy">ObjectLayer:destroy</a>&nbsp;()</td>
	<td class="summary">Completely removes all visual and physical objects associated with the TileLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:drag">ObjectLayer:drag</a>&nbsp;(event)</td>
	<td class="summary">Drags the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getObject">ObjectLayer:getObject</a>&nbsp;(name, objectType)</td>
	<td class="summary">Get an object by its name.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getObjects">ObjectLayer:getObjects</a>&nbsp;(name, objectType)</td>
	<td class="summary">Get a list of objectd by there name.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getObjectsOfType">ObjectLayer:getObjectsOfType</a>&nbsp;(objectType)</td>
	<td class="summary">Gets a list of Objects on this ObjectLayer that have a certain type.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getObjectsWithName">ObjectLayer:getObjectsWithName</a>&nbsp;(name)</td>
	<td class="summary">Gets a list of Objects on this ObjectLayer that have a certain name.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getObjectsWithProperty">ObjectLayer:getObjectsWithProperty</a>&nbsp;(name)</td>
	<td class="summary">Gets a list of Objects on this ObjectLayer that have a specified property.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getProperties">ObjectLayer:getProperties</a>&nbsp;()</td>
	<td class="summary">Gets a list of all Properties of the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getProperty">ObjectLayer:getProperty</a>&nbsp;(name)</td>
	<td class="summary">Gets a Property of the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getPropertyCount">ObjectLayer:getPropertyCount</a>&nbsp;()</td>
	<td class="summary">Gets a count of how many properties the Object Layer has.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:getPropertyValue">ObjectLayer:getPropertyValue</a>&nbsp;(name)</td>
	<td class="summary">Gets the value of a Property of the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:hasProperty">ObjectLayer:hasProperty</a>&nbsp;(name)</td>
	<td class="summary">Checks whether the ObjectLayer has a certain Property.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:hideDebugImages">ObjectLayer:hideDebugImages</a>&nbsp;()</td>
	<td class="summary">Hides all debug images on the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:move">ObjectLayer:move</a>&nbsp;(x, y)</td>
	<td class="summary">Moves the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:new">ObjectLayer:new</a>&nbsp;(data, map)</td>
	<td class="summary">Create a new instance of an ObjectLayer object.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:removeProperty">ObjectLayer:removeProperty</a>&nbsp;(name)</td>
	<td class="summary">Removes a Property from the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:setProperty">ObjectLayer:setProperty</a>&nbsp;(name, value)</td>
	<td class="summary">Sets the value of a Property of the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:showDebugImages">ObjectLayer:showDebugImages</a>&nbsp;()</td>
	<td class="summary">Shows all debug images on the ObjectLayer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#ObjectLayer:toggleDebugImagesVisibility">ObjectLayer:toggleDebugImagesVisibility</a>&nbsp;()</td>
	<td class="summary">Toggles the visibility of all debug images on the ObjectLayer.</td>
	</tr>

</table>






<br/>
<br/>




<h2><a name="functions"></a>Functions</h2>
<dl class="function">



<dt><a name="ObjectLayer:addProperty"></a><strong>ObjectLayer:addProperty</strong>&nbsp;(property)</dt>
<dd>
Adds a Property to the ObjectLayer.


<h3>Parameters</h3>
<ul>
	
	<li>
	  property: The Property to add.
	</li>
	
</ul>






<h3>Return value:</h3>
The added Property.



</dd>




<dt><a name="ObjectLayer:build"></a><strong>ObjectLayer:build</strong>&nbsp;()</dt>
<dd>
Builds the physical representation of the ObjectLayer.









</dd>




<dt><a name="ObjectLayer:create"></a><strong>ObjectLayer:create</strong>&nbsp;()</dt>
<dd>
Creates the visual debug representation of the ObjectLayer.









</dd>




<dt><a name="ObjectLayer:destroy"></a><strong>ObjectLayer:destroy</strong>&nbsp;()</dt>
<dd>
Completely removes all visual and physical objects associated with the TileLayer.









</dd>




<dt><a name="ObjectLayer:drag"></a><strong>ObjectLayer:drag</strong>&nbsp;(event)</dt>
<dd>
Drags the ObjectLayer.


<h3>Parameters</h3>
<ul>
	
	<li>
	  event: The Touch event.
	</li>
	
</ul>








</dd>




<dt><a name="ObjectLayer:getObject"></a><strong>ObjectLayer:getObject</strong>&nbsp;(name, objectType)</dt>
<dd>
Get an object by its name.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the Object to get.
	</li>
	
	<li>
	  objectType: The type of the Object to get. Optional.
	</li>
	
</ul>






<h3>Return value:</h3>
The found Object. nil if none found.



</dd>




<dt><a name="ObjectLayer:getObjects"></a><strong>ObjectLayer:getObjects</strong>&nbsp;(name, objectType)</dt>
<dd>
Get a list of objectd by there name.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the Objects to get.
	</li>
	
	<li>
	  objectType: The type of the Objects to get. Optional.
	</li>
	
</ul>






<h3>Return value:</h3>
A list of the found Objects. Empty if none found.



</dd>




<dt><a name="ObjectLayer:getObjectsOfType"></a><strong>ObjectLayer:getObjectsOfType</strong>&nbsp;(objectType)</dt>
<dd>
Gets a list of Objects on this ObjectLayer that have a certain type.


<h3>Parameters</h3>
<ul>
	
	<li>
	  objectType: - The type of the Object to look for.
	</li>
	
</ul>






<h3>Return value:</h3>
A list of found Objects. Empty if none found.



</dd>




<dt><a name="ObjectLayer:getObjectsWithName"></a><strong>ObjectLayer:getObjectsWithName</strong>&nbsp;(name)</dt>
<dd>
Gets a list of Objects on this ObjectLayer that have a certain name.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the Object to look for.
	</li>
	
</ul>






<h3>Return value:</h3>
A list of found Objects. Empty if none found.



</dd>




<dt><a name="ObjectLayer:getObjectsWithProperty"></a><strong>ObjectLayer:getObjectsWithProperty</strong>&nbsp;(name)</dt>
<dd>
Gets a list of Objects on this ObjectLayer that have a specified property.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the Property to look for.
	</li>
	
</ul>






<h3>Return value:</h3>
A list of found Objects. Empty if none found.



</dd>




<dt><a name="ObjectLayer:getProperties"></a><strong>ObjectLayer:getProperties</strong>&nbsp;()</dt>
<dd>
Gets a list of all Properties of the ObjectLayer.







<h3>Return value:</h3>
The list of Properties.



</dd>




<dt><a name="ObjectLayer:getProperty"></a><strong>ObjectLayer:getProperty</strong>&nbsp;(name)</dt>
<dd>
Gets a Property of the ObjectLayer.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the Property.
	</li>
	
</ul>






<h3>Return value:</h3>
The Property. nil if no Property found.



</dd>




<dt><a name="ObjectLayer:getPropertyCount"></a><strong>ObjectLayer:getPropertyCount</strong>&nbsp;()</dt>
<dd>
Gets a count of how many properties the Object Layer has.







<h3>Return value:</h3>
The Property count.



</dd>




<dt><a name="ObjectLayer:getPropertyValue"></a><strong>ObjectLayer:getPropertyValue</strong>&nbsp;(name)</dt>
<dd>
Gets the value of a Property of the ObjectLayer.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the Property.
	</li>
	
</ul>






<h3>Return value:</h3>
The Property value. nil if no Property found.



</dd>




<dt><a name="ObjectLayer:hasProperty"></a><strong>ObjectLayer:hasProperty</strong>&nbsp;(name)</dt>
<dd>
Checks whether the ObjectLayer has a certain Property.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the property to check for.
	</li>
	
</ul>






<h3>Return value:</h3>
True if the ObjectLayer has the Property, false if not.



</dd>




<dt><a name="ObjectLayer:hideDebugImages"></a><strong>ObjectLayer:hideDebugImages</strong>&nbsp;()</dt>
<dd>
Hides all debug images on the ObjectLayer.









</dd>




<dt><a name="ObjectLayer:move"></a><strong>ObjectLayer:move</strong>&nbsp;(x, y)</dt>
<dd>
Moves the ObjectLayer.


<h3>Parameters</h3>
<ul>
	
	<li>
	  x: The amount to move the ObjectLayer along the X axis.
	</li>
	
	<li>
	  y: The amount to move the ObjectLayer along the Y axis.
	</li>
	
</ul>








</dd>




<dt><a name="ObjectLayer:new"></a><strong>ObjectLayer:new</strong>&nbsp;(data, map)</dt>
<dd>
Create a new instance of an ObjectLayer object.


<h3>Parameters</h3>
<ul>
	
	<li>
	  data: The XML data.
	</li>
	
	<li>
	  map: The current Map object.
	</li>
	
</ul>






<h3>Return value:</h3>
The newly created object layer.



</dd>




<dt><a name="ObjectLayer:removeProperty"></a><strong>ObjectLayer:removeProperty</strong>&nbsp;(name)</dt>
<dd>
Removes a Property from the ObjectLayer.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the Property to remove.
	</li>
	
</ul>








</dd>




<dt><a name="ObjectLayer:setProperty"></a><strong>ObjectLayer:setProperty</strong>&nbsp;(name, value)</dt>
<dd>
Sets the value of a Property of the ObjectLayer. Will create a new Property if none found.


<h3>Parameters</h3>
<ul>
	
	<li>
	  name: The name of the Property.
	</li>
	
	<li>
	  value: The new value.
	</li>
	
</ul>








</dd>




<dt><a name="ObjectLayer:showDebugImages"></a><strong>ObjectLayer:showDebugImages</strong>&nbsp;()</dt>
<dd>
Shows all debug images on the ObjectLayer.









</dd>




<dt><a name="ObjectLayer:toggleDebugImagesVisibility"></a><strong>ObjectLayer:toggleDebugImagesVisibility</strong>&nbsp;()</dt>
<dd>
Toggles the visibility of all debug images on the ObjectLayer.









</dd>


</dl>







</div> <!-- id="content" -->

</div> <!-- id="main" -->

<div id="about">
	<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->

</div> <!-- id="container" -->	
</body>
</html>
